home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 24 / AACD 24.iso / AACD / Online / Epic4 / share / epic / help / 6_functions / onchannel < prev    next >
Text File  |  2001-03-21  |  2KB  |  42 lines
  1. Synopsis:
  2.    $onchannel([<channel>|*])
  3.  
  4. Technical:
  5.    This function returns a list of users currently on the specified channel.
  6.    It will only operate for channels that the client is currently on.
  7.  
  8. Practical:
  9.    This function basically does the same thing as NAMES, except is much
  10.    faster.  However, it only functions on the client's current channels.
  11.    If no channel is specified, the current is used.  Similarly, a "*" will
  12.    expand to the current channel.
  13.  
  14. Returns:
  15.    list of nicknames on specified channel, or nothing if error
  16.  
  17. Examples:
  18.    $onchannel()                  shows users on current channel
  19.    $onchannel(*)                 also shows users on current channel
  20.    $onchannel(#foobar)           shows users on #foobar if client is there
  21.  
  22. Aliases:
  23.    The $chanusers() function is identical in operation to $onchannel().
  24.  
  25. See Also:
  26.    names(2)
  27.  
  28. Bugs:
  29.    There is a long-standing bug in many servers that can lead to erroneous
  30.    output from this function.  These servers limit the length of numeric
  31.    353 (RPL_NAMEREPLY) to 510 characters.  When the nickname list exceeds
  32.    this, the server uses multiple 353s.  Unfortunately, they will truncate
  33.    any nickname that would end up exceeding the 510th character.  This
  34.    function uses 353 to generate it's initial nickname list, so it is
  35.    likely that it will return chopped nicknames on large channels.  This is
  36.    an unavoidable server bug.
  37.  
  38. Other Notes:
  39.    This function will fail on channels with mode +a set (ircd 2.9 servers),
  40.    as those channels do not permit a listing of users.
  41.  
  42.